home *** CD-ROM | disk | FTP | other *** search
/ Resource Library: Multimedia / Resource Library: Multimedia.iso / hypertxt / msdos / hpchdk10 / hpc2hdk.doc < prev    next >
Encoding:
Text File  |  1993-05-24  |  4.0 KB  |  108 lines
  1. HPC2HDK
  2.  
  3. Version 1.0   24-5-93
  4.  
  5. (C) 1993  Yaniv Golan  All Rights Reserved
  6.  
  7. ----------------------------------------------------------------------
  8.  
  9.  
  10. Purpose
  11. -------
  12. HPC2HDK is a convertor which takes the *.TXT files used by HelpPC version
  13. 2.10 and creates HDF files which are meant to be compiled with helpC - part
  14. of the HelpDK package.
  15.  
  16. HelpPC is a sharware program written by David Jurgens - it's a hypertext
  17. browser with quite a lot of usefull information for DOS / PC programmers.
  18.  
  19. HelpDK is a sharware package written by Ron Loewy. It's a compiler which
  20. creates help files for various platforms (MS Windows, DesqView/X, Borland's
  21. IDEs, QuickHelp and others) from a single source file.
  22.  
  23.  
  24. How to use?
  25. -----------
  26. Typing HPC2HDK without parameters will produce the following help screen:
  27.  
  28. HPC2HDK 1.0   By Yaniv Golan  (C) 1993
  29.  
  30. Converts HelpPC files to HelpDK files.
  31.  
  32. USAGE: HPC2HDK [<files list> | <@listfile> ] [options]
  33.  
  34.        files list is a list of the source files seperated by spaces and
  35.        with .TXT assumed as extension unless otherwise specified.
  36.        Alternativly, if @listfile is used, listfile be a text file containing
  37.        on each of it's lines the name of a source file.
  38.  
  39.        Options : 
  40.  
  41.        /C<corrections file> - the name of a text file containing a list
  42.                               of corrections to the source files.
  43.        /O<main output file> - the name of the main index file that will 
  44.                               be created. Default is HELPPC.HDF.
  45.  
  46.  
  47.  
  48. The corrections file is a file which is needed to solve some mistakes
  49. in the HelpPC database such as incorrect or missing links. The format
  50. of this file is very simple - each line should contain two enteries
  51. seperated with a colon (':'). The first one is the link as it appears
  52. in the source files, and the second one is the link as it should appear
  53. in the generated files. For example, the following line :
  54.  
  55. device commands:device command codes
  56.  
  57. means that each occourence of the link 'device commands' in the source files
  58. should be replaced with a reference to the topic 'device command codes'.
  59.  
  60. The file 'difile' contains all the corrections needed to compile the
  61. original HelpPC database. If you have added your own files to the data
  62. base, you can add enteries to this file if neccessary.
  63. Each correction and missing link will produce a warning during the
  64. conversion. At the end of the conversion of the original HelpPC database,
  65. the convertor should report a total of 81 warnings. If such is the case,
  66. then the conversion was succesfull. 
  67.  
  68. The file 'helppc.lst' contains the list of the files found in the
  69. original HelpPC package. Edit it so that it contains the correct path
  70. to the files on your disk if they are not in the correct diretory.
  71. Notice that the output files will be created in the current directory.
  72.  
  73. Use the batch file DOHELPPC.BAT to compile the database using the default
  74. settings. Make sure that 'difile' and 'helppc.lst' are in the same
  75. directory, and that 'helppc.lst' is correct.
  76.  
  77. Bugs (there are non ofcourse), corrections and suggestions can be
  78. sent to me through email at s2942275@techst02.technion.ac.il or 
  79. through snail mail to :
  80.  
  81. Golan Yaniv
  82. P.O.B 442
  83. Technion City, HAIFA 32000
  84. ISRAEL
  85.  
  86. Please note that the resulting HDF files are meant to be compiled with
  87. helpC version 4.0 and above.
  88.  
  89.  
  90. Disclaimer
  91. ----------
  92. Standard disclaimer apply. Use it at your own risk. Up till now this
  93. program didn't reformat the hard disks it was tested on, but David Yum
  94. already proved that this cannot be relied on.
  95.  
  96.  
  97. Credits
  98. -------
  99. MS Windows and QuickHelp are trademarks of Microsoft corp.
  100. DesqView/X is a trade mark of Quartdeck.
  101.  
  102. Major credits should go to David Jurgens for his highly usefull program.
  103.  
  104. The same goes for Ron Loewy, whose helpC compiler greatly simplifies writing
  105. help screens for all those wiered formats, and whose computer was busy
  106. for a long time doing beta for this program while this program was doing
  107. beta for his helpC :-)
  108.